Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Specify the fully qualified name of @OpenAPI.extension decorator in missing-x-ms-identifiers linter warning #605

Merged
merged 2 commits into from
Apr 5, 2024
Merged

Specify the fully qualified name of @OpenAPI.extension decorator in missing-x-ms-identifiers linter warning #605

merged 2 commits into from
Apr 5, 2024

Conversation

mjlshen
Copy link
Contributor

@mjlshen mjlshen commented Apr 5, 2024

Fixes #604 and also resolves a syntax error in the documentation for missing-x-ms-identifiers.

timotheeguerin
timotheeguerin approved these changes Apr 5, 2024
View reviewed changes
Copy link
Member

@timotheeguerin timotheeguerin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh nice, thanks for the fix, just need to describve the change as fix either using the comment on the PR or using pnpm change add

@timotheeguerin
Copy link
Member

/azp run try it

@timotheeguerin
Copy link
Member

/azp run typespec-azure - PR Try It

@azure-pipelines Azure Pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@azure-sdk
Copy link
Collaborator

❌ There is undocummented changes. Run chronus add to add a changeset or click here.

The following packages have changes but are not documented.

  • ❌@azure-tools/typespec-azure-resource-manager

@mjlshen mjlshen changed the title Provide correct decorater to resolve missing-x-ms-identifiers Specify the fully qualified name of @OpenAPI.extension decorator in missing-x-ms-identifiers linter warning. Apr 5, 2024
@mjlshen mjlshen changed the title Specify the fully qualified name of @OpenAPI.extension decorator in missing-x-ms-identifiers linter warning. Specify the fully qualified name of @OpenAPI.extension decorator in missing-x-ms-identifiers linter warning Apr 5, 2024
@timotheeguerin
Copy link
Member

ah yeah looks like you'll have to update the test that were expecting the old message as well, there is also a formatting issue, make sure to run pnpm format at the end

@mjlshen
Copy link
Contributor Author

mjlshen commented Apr 5, 2024

I'm having trouble setting up my development environment locally/in VSCode. I was going through https://github.com/microsoft/typespec/blob/main/CONTRIBUTING.md

but I'm running into errors like:

❯ pnpm install      
Scope: all 12 workspace projects
/Users/mshen/git/Azure/typespec-azure/packages/e2e-tests:
 ERR_PNPM_WORKSPACE_PKG_NOT_FOUND  In packages/e2e-tests: "@typespec/compiler@workspace:~" is in the dependencies but no package named "@typespec/compiler" is present in the workspace

This error happened while installing a direct dependency of /Users/mshen/git/Azure/typespec-azure/packages/e2e-tests

Packages found in the workspace: @azure-tools/typespec-azure-monorepo, @azure-tools/e2e-tests, @azure-tools/typespec-samples, @azure-tools/typespec-autorest, @azure-tools/typespec-autorest-canonical, @azure-tools/typespec-azure-core, @azure-tools/typespec-azure-playground-website, @azure-tools/typespec-azure-portal-core, @azure-tools/typespec-azure-resource-manager, @azure-tools/typespec-client-generator-core, @azure-tools/typespec-service-csharp, @azure-tools/typespec-azure-website

❯ pnpm format      

> @azure-tools/[email protected] format /Users/mshen/git/Azure/typespec-azure
> pnpm run prettier --write


> @azure-tools/[email protected] prettier /Users/mshen/git/Azure/typespec-azure
> prettier . --config .prettierrc.json "--write"

[error] Cannot find module '/Users/mshen/git/Azure/typespec-azure/core/packages/prettier-plugin-typespec/dist/index.js' imported from /Users/mshen/.npm-global/lib/node_modules/prettier/index.mjs
 ELIFECYCLE  Command failed with exit code 1.
 ELIFECYCLE  Command failed with exit code 1.

@timotheeguerin
Copy link
Member

timotheeguerin commented Apr 5, 2024 •
edited
Loading

ah that sounds like you haven't clone the core submodule, see this doc on how do make this work https://github.com/Azure/typespec-azure/blob/main/CONTRIBUTING.md#working-with-the-core-submodule

I have been thinking of adding a dev container setup so simplify setup for contributors, do you think that's something that would have benefited you here?

@mjlshen
Copy link
Contributor Author

mjlshen commented Apr 5, 2024

Oh that's perfect - I just didn't realize those steps were important. I'm not very familiar with JS yet, so I went down the wrong rabbithole.

A devcontainer wouldn't hurt, but the steps you linked worked as well. I mistakenly skipped to the Azure/typespec CONTRIBUTING.md searching for pnpm guidance.

@mjlshen mjlshen force-pushed the 604 branch 2 times, most recently from fb9943d to 3884fe0 Compare April 5, 2024 20:36
@mjlshen
Specify the fully qualified name of @OpenAPI.extension decorator in…
79a00e5 
… `missing-x-ms-identifiers` linter warning.

Signed-off-by: Michael Shen <[email protected]>
@mjlshen
Fix syntax error in x-ms-identifiers documentation
971f4b0 
Signed-off-by: Michael Shen <[email protected]>
auto-merge was automatically disabled April 5, 2024 21:00

Head branch was pushed to by a user without write access

@timotheeguerin timotheeguerin added this pull request to the merge queue Apr 5, 2024
Merged via the queue into Azure:main with commit 5b7bf8f Apr 5, 2024
17 checks passed
@mjlshen mjlshen deleted the 604 branch April 6, 2024 03:18
@mjlshen
Copy link
Contributor Author

mjlshen commented Apr 6, 2024

Thank you @timotheeguerin for taking the time to walk me through this PR!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@timotheeguerin timotheeguerin timotheeguerin approved these changes

@bterlson bterlson Awaiting requested review from bterlson bterlson is a code owner

@markcowl markcowl Awaiting requested review from markcowl markcowl is a code owner

@allenjzhang allenjzhang Awaiting requested review from allenjzhang allenjzhang is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Bug]: missing-x-ms-identifiers misleading messages
3 participants
@mjlshen @timotheeguerin @azure-sdk